Set Up Data Exports

Learn how to turn on Data Exports for the first time.

Note: To enable this feature, contact Visier Technical Support.

Data Exports allow users to leverage Visier metrics and data outside the solution. For more information, see Data Exports.

There are two types of Data Exports to chose from:

  • Aggregated Data Export: Retrieve data containing metric values. For example, Headcount and Resignation Rate.
  • Detailed Data Export: Retrieve data containing attribute values for individual subjects (such as employees, candidates, and requisitions) and events (such as starts, exits, and pay changes).

In addition, users that have the Author Data Exports capability need access to an application programming interface key (API key), which you can generate in the Settings room in the global workspace. If you can't access the Settings room, contact Visier Technical Support for an API key.

If your organization has single sign-on enabled, you'll also need to generate a password for users that have the Consume Data Exports capability.

Initial Data Exports set up

Use the following workflow when setting up Data Exports for the first time.

Step One: Contact Visier Technical Support to turn on Data Exports

This feature is not enabled by default, so you'll have to contact a member of the Visier Technical Support team to use Data Exports. After we receive your request, we will enable this feature and send you an approved project for validation. For more information, see Validate a project.

For Data Export links to work correctly, the link must contain your organization's API key. The API key acts as a unique identifier and allows you to make API requests or integrations with Visier. When you make your initial feature request, we also generate an API key for your organization. Once generated, the API key will automatically be included in each Data Export link that is created.

Step Two: Generate an API key for an analytic tenant

Each tenant has a unique API key. An administrating tenant administrator can generate an API key for their analytic tenants in the studio experience.

To generate an analytic tenant's API key:

  1. Open the analytic tenant.
  2. On the global navigation bar, click Settings > API Keys.
  3. Click Generate.

Once generated, the API key is automatically included in each Data Export link that the analytic tenant creates. For more information, see Generate an API Key.

Step Three: Assign capabilities to users and User Groups

After Data Exports have been turned on, you'll need to update your permissions or User Groups to give the Author Data Exports and Consume Data Exports capabilities to your users. For more information, see Permission Management.

Data Exports and single sign-on

If your organization uses single sign-on, you'll need to generate a unique password for users that have the Consume Data Exports capability. In order to fetch data using the Data Export link, users are required to manually authenticate by entering their username and password.

To generate a password:

  1. On the global navigation bar, click Tenant, and then click the Users tab.

  2. Select a user in the Users list.

  3. Click Reset Password for Data Export in the User Details area.

  4. In the Reset User Password dialog do one of the following:

    • To get the password reset link, click Copy Link.
    • To send the password reset link via email, click Send email.

      Result: Your default email application opens a new email that contains a password reset link.

Note: The password reset link is valid for 24 hours.

When a user leaves your organization, you must delete their user account from Visier or remove access to the Consume Data Exports capability. Even if you remove a user from your Identity Provider (IdP), they can still use the Data Export if their Visier account has access to the Consumer Data Exports capability.

Turn off Data Exports

After the initial setup, you can turn off the Data Exports endpoint at anytime.

  1. In a project, on the navigation bar, click Model > Settings > Data Export.
  2. Click the toggle button to turn off the Data Exports endpoint.

    Result: All existing Data Exports will stop working. Users will not be able to consume any data.